MAP_GetSoundModule
Reads the IO map of the sound module
Contents
Syntax
map = MAP_GetSoundModule()
Description
map = MAP_GetSoundModule() returns the IO map of the sound module. The return value map is a struct variable. It contains all sound module information.
Output:
map.Frequency % frequency of the last played ton in Hz
map.Duration % duration of the last played ton in ms
map.SamplingRate % current sound sample rate
map.SoundFileName % sound file name of the last played sound file
map.Flags % sound module flag, 'IDLE': sound module is idle, 'UPDATE': a request for plackback is pending, 'RUNNING': playback in progress.
map.State % sound module state, 'IDLE'; sound module is idel, 'PLAYING_FILE': sound module is playing a .rso file, 'PLAYING_TONE': a tone is playing, 'STOP': a request to stop playback is in progress.
map.Mode % sound module mode, 'ONCE': only play file once , 'LOOP': play file in a loop, 'TONE': play tone.
map.Volume % volume: 0: diabled, 1: 25%, 2:50%, 3:75%, 4:100% of full volume
Examples
map = MAP_GetSoundModule();
See also
Signature
- Author: Alexander Behrens (see AUTHORS)
- Date: 2008/05/22
- Copyright: 2007-2008, RWTH Aachen University